导航菜单
首页 >  可立图API文档  > 可立图证件照API

可立图证件照API

1.人像抠图接口

地址:https://www.clipimg.com/api/human/matting

请求方式:POST

数据类型:form

计费:formate为png或zip时调用成功扣除50点,formate为json时下载无水印结果图片再扣除50点、请求有水印图片不扣点

参数[Header]

参数名说明是否必选类型X-API-Key秘钥必选stringContent-Type请求数据类型必选multipart/form-data 或 application/json

参数[Body]:

参数名说明是否必选类型filecontent-type为multipart/form-data时传递图片二进制流,为application/json时传递图片的base64格式,不包含base64的头部数据必选二进制流、stringformate返回数据格式可选string

formate取值

png人像透明图片zip包含alpha图片的人像alpha图片jsonjson格式数据,包含预览图(含水印)地址和下载(无水印)地址,预览免费,下载无水印图片扣费

返回:

httpcode为200时:formate不传值或传png时,返回png二进制流;为zip时返回包含alpha文件、png文件的zip压缩包二进制流;为json格式时数据,返回json格式数据,包含预览图(含水印)地址和下载(无水印)地址,预览免费,下载无水印图片扣费

httpcode为402时表示点数已用完

httpcode为400时表示文件上传错误

httpcode为413时表示文件上传超过大小限制

httpcode为403时表示账号异常

2.证件照接口

地址:https://www.clipimg.com/api/idphoto/make

请求方式:POST

数据类型:JSON

响应类型:JSON

计费:此接口不产生费用

接口描述:此接口为证件照制作接口,调用不产生费用,结果保留1小时,1小时后自动删除制作结果图片,请及时保存。重复下载同一张照片不会重复扣费。

参数[Header]

参数名说明是否必选类型X-API-Key秘钥必选stringContent-Type请求数据类型必选application/json

参数[Body]:

参数名说明是否必选类型file图片的base64格式,不包含base64的头部数据必选stringspec_id规格id可选,width、height不传值时必传intwidth宽度px可选,spec_id不传值时必传intheight高度px可选,spec_id不传值时必传intfair_level美颜级别可选,0-1之间的小数,为0时不美颜floatcolor背景色可选,默认值蓝红白三种颜色listfacepose人脸是否正对摄像头误差范围可选,越小越严格,越大容错率越高,默认:20floateyeskew双眼倾斜误差范围可选,越小越严格,越大容错率越高,默认:20floatface_ratio_min头部最小比例可选,默认0.6floatface_ratio头部最大比例可选,默认0.67floatdpi返回的证件照分辨率,如果不设置该值,服务端会给出默认配置,一般返回300dpi的图片 可选inthead_top_gap_ratio头顶发迹离上边缘距离可选,默认0.1floateyes_to_botttom_ratio_min眼睛离下边缘最小距离可选,默认0.46floatenhance_image_quality是否对图像做清晰化处理可选,默认为1,1表示是,0表示否int

color结构

参数名说明类型name背景色名称stringstart_color背景色值strngenc_color渐变色色值,可选,不传值时为纯色背景string

返回:

参数说明示例类型code状态码0intmsg错误详情成功stringdata结果  

code取值

0请求成功402 点数已用完407未检测到人脸408包含多人412双眼倾斜,超过误差范围413人脸倾斜,超过误差范围

data结构体

参数名说明示例值类型image_id上传图片的标示d00a42c…0dc18946stringfilenames证件照列表[{‘preview_url’: ‘https://…’, ‘preview_img_name’: ‘d00a4…_white_preview’, ‘download_url’: ‘https://…’, ‘img_name’: ‘d00a4…_white’, ‘color_name’: ‘white’,’bg_color’: ‘#FFFFFF’}, …]list

filenames结构

参数名说明示例值类型preview_url预览图片地址https://…stringpreview_img_name预览图名称,用于再次下载d00a4…_whitestringdownload_url原图下载地址https://…stringimg_name证件照名称,用于再次下载、换装d00a4…_whitestringcolor_name背景色名称whitestringbg_color背景色色值#FFFFFFstringprint_img_name打印排版照原图名称d00a4…_print_whitestringpreview_print_img_name 打印排版照预览图名称d00a4…_print_whitestringprint_url排版照原图下载地址https://…stringpreview_print_url排版照预览图下载地址https://…string

 

相关推荐: